home *** CD-ROM | disk | FTP | other *** search
/ Aminet 3 / Aminet 3 - July 1994.iso / Aminet / util / misc / ECopy.lha / ECopy / ECopy.doc < prev    next >
Encoding:
Text File  |  1994-04-05  |  8.0 KB  |  214 lines
  1.  
  2.                  ============================================
  3.                   ECopy V1.10  Economical File Copy Utilitiy
  4.                                 Documentation
  5.                             - February 20, 1994 -
  6.                  ============================================
  7.  
  8.  
  9.             Copyright (c) 1992-1994 by Sam Yee.  All rights reserved.
  10.  
  11.  
  12.  
  13.  
  14. COPYRIGHT
  15. ---------
  16.  
  17. The program ECopy and its documentation are written and copyrighted by
  18. Sam  Yee.   They  may  be  distributed  freely providing the following
  19. restrictions are satisfied:
  20.  
  21. o Distributors may not charge more than the cost of a diskette used in
  22.   the distribution of this program.
  23.  
  24. o Distributors may only distribute the unmodified copy of the original
  25.   program,  source  file, along with it's documentation, and copyright
  26.   notices intact.
  27.  
  28. o Commercial  distribution  is  only  possible with written permission
  29.   from the author.
  30.  
  31.  
  32. DISCLAIMER
  33. ----------
  34.  
  35. This program and its documentation is provided "as is".  No warranties
  36. are  made  with  respect  to the accuracy, reliability, performance or
  37. operation  of  this  software  and  information.   You  are using this
  38. program  at  your  own risk.  The author is not liable for any damages
  39. that may have been caused by using this software.
  40.  
  41.  
  42. INTRODUCTION
  43. ------------
  44.  
  45. Have  you  ever  wanted  to copy files from your harddrive onto floppy
  46. disks,  so  that  the  number of disks used is kept at a minimum?  For
  47. example,  you  have  hundreds  of IFF/GIF pictures or sound files (eg.
  48. modules)  on  your  harddrive,  and  you wanted to copy them to disks.
  49. Now,  a  hundred  files  of  moderate  size would take many disks.  Of
  50. course  you  may say, why don't I use a harddrive backup program?  The
  51. problem  with  this method is that if you want to retrieve a file from
  52. the backup disks it would take a long time.  ECopy is a simple utility
  53. that allows you to copy files from harddrive to disks easily.
  54.  
  55.  
  56. REQUIREMENTS
  57. ------------
  58.  
  59. This program runs on any Amiga with OS 2.04 or higher.
  60.  
  61.  
  62. COMMAND USAGE
  63. -------------
  64.  
  65. ECopy  must  be  run  from the CLI/Shell and has the following command
  66. line template:
  67.  
  68. FROM/M,TO/A,QUIET/S,BUF=BUFFER/K/N,CLONE/S,LISTNC/S,MOVE/S,
  69. RES=RESERVE/K/N,SUF=SUFFIX/K,BLOCKCAP/K/N,FORCE/S,READFILE/K,
  70. NCTOFILE/K
  71.  
  72. Where:
  73.  
  74. FROM
  75.     This optional keyword specifies where to copy the files from.
  76.     E.g., "ECopy C: T: SYS: #?.IFF TO DF0:".
  77.  
  78. TO
  79.     This optional keyword specifies where to copy the files to.
  80.     E.g., "ECopy MODS:A#? TO DF0:".
  81.  
  82. QUIET
  83.     This  option  causes  the  filenames  not  to  be  displayed while
  84.     copying.  E.g., "ECopy #? DF0: QUIET".
  85.  
  86. BUF=BUFFER
  87.     This  option is for setting the buffer size (in kilobytes) used in
  88.     the  copying  process.   The closer the buffer size is to the file
  89.     size,  the  faster  the program will copy.  A buffer size of 8K is
  90.     generally  good.   E.G.,  "ECopy BUF 4 #?  DF0:" will copy all the
  91.     files  in  the  current  directory to the disk drive "DF0:" with a
  92.     4096 bytes buffer.  BUFFER and BUF are analogous.
  93.  
  94. CLONE
  95.     This  option  is  for  cloning  the  copied files so that both the
  96.     source  and  destination  files have the same dates, comments, and
  97.     protection bits.
  98.  
  99. LISTNC
  100.     If  option  is specified all those files not copied will be output
  101.     to the standard output and/or to the file specified by NCTOFILE.
  102.     E.g., "ECopy #?.GIF DF0: LISTNC".
  103.  
  104. MOVE
  105.     This  option  is  for  moving  files  from  the  source  files and
  106.     directories  to  the destination disk.  That is, a file is deleted
  107.     after  it's copied.  All files protected from deletion will not be
  108.     deleted,  unless  the FORCE option is specified.  If a file cannot
  109.     be  copied the original copy is not deleted.  Cloning is automatic
  110.     with  this  option  enabled,  so  the  CLONE  keyword  need not be
  111.     specified.  E.g., "ECopy MOVE FROM PICS: TO DF0:"
  112.  
  113. RES=RESERVE
  114.     This  will  allow  you  to  reserve  a  number of kilobytes on the
  115.     destination  disk.   Note  that  the  unused  space on the disk is
  116.     usually  more  than  the  reserved  size  you  specified.   It  is
  117.     particular  useful  if  you  want  to  add small programs, such as
  118.     viewers, players, and "readme" files, to each disk.
  119.  
  120. SUF=SUFFIX
  121.     This  will  append a suffix name to each file that is copied.  For
  122.     example,  "ECopy SUF .bak myfile DF0:" will copy "myfile" from the
  123.     current  directory  into  "DF0:myfile.bak".   This  is  particular
  124.     useful for backups.
  125.  
  126. BLOCKCAP
  127.     This  option allows you to specify how many bytes in each block is
  128.     actually capable of storing file data.  For example, for OFS disks
  129.     it's  488  bytes  per  block and FFS disks it's 504 bytes.  If the
  130.     disks  you are using are formatted with either OFS or FFS you need
  131.     not specify this option.  The program uses this value to determine
  132.     if  a  file  to  be copied will fit in the disk.  If you are using
  133.     MSDOS  disks,  it  assumes 512 bytes are usable on each block.  If
  134.     this  option  is  not  specified,  the program will assume all the
  135.     bytes in a block are capable of storing file data.
  136.     E.g., "ECopy #?.SND XF0: BLOCKCAP 500".
  137.  
  138. FORCE
  139.     When specified, all deletion of files are forced even if the files
  140.     are  protected  from deletion.  If the destination disk contains a
  141.     file  protected  from  deletion, with the same name as one of your
  142.     source  files,  the destination file will be deleted and replaced.
  143.     When  you  are moving files (specified by MOVE), upon a successful
  144.     moves,  the  source  files  will be deleted even if they're delete
  145.     protected.  E.g., "ECopy #?  DF0:  FORCE".
  146.  
  147. READFILE
  148.     Normally,  you  specify  the  files to copy from the command line.
  149.     However,  you may also read these names from a file.  If you don't
  150.     want  to  specify  any  file  on the command line, you must use an
  151.     invalid  file  name  (such as NIL:) to trick the OS when it parses
  152.     the  command  line  options.   E.g., "ECopy mod.#?  DF0:  READFILE
  153.     MODFILES".   E.g.,  "ECopy  NIL:   DF0:   READFILE  PICFILES", but
  154.     ignore  the  error  message,  "NIL::   device  (or  volume) is not
  155.     mounted".
  156.  
  157. NCTOFILE/K
  158.     In the event that not all files are copied, this option allows you
  159.     to  specify a file to write theese file names to.  The output file
  160.     can then be used at a later time via the READFILE option.
  161.     E.g., "ECopy #? DF0: NCTOFILE nocopy.txt".
  162.  
  163. Options  can  be  placed  anywhere  on  the  command line.  During the
  164. copying,  press ^C (control-C) to abort.  Any incomplete files will be
  165. deleted from the destination disk.  After each disk is nearly full and
  166. further copying is not possible, a message will be displayed:
  167.  
  168. <disk>: disk full
  169.  
  170. <x> more files to be copied.
  171.  
  172. [R]etry, [C]hange disk, or [A]bort?
  173.  
  174. Now  put  in a new disk, and press "R" and the copying process resumes
  175. with  the same destination disk name.  Press "A" to abort copying.  If
  176. you  want to change the destination path, press "C" and a message will
  177. be displayed:
  178.  
  179. Enter new disk name [<disk>]:
  180.  
  181. Now, type something like "DF1:" or "DF2:" if you want to copy to other
  182. drives.   If  you just press return the destination disk name will not
  183. be changed.
  184.  
  185.  
  186. EFFICIENCY
  187. ----------
  188.  
  189. I have tested the program on picture files, and music files of various
  190. sizes  and  came  up  with only about an average of 1/2% to 1% of disk
  191. space  wasted.   Your  mileage  may  vary,  depending on the file size
  192. distribution of all the files you are copying.  Of course, it's always
  193. possible  to  manually  copy  files  with  0%  space  wasted,  but the
  194. calculations  required  makes  it  impractical.   Before  I wrote this
  195. utility, each disk I copied manually ended up with an average of about
  196. 5-10%  disk space wasted.  If you collect pictures or sound files, you
  197. can save some disks and time!
  198.  
  199.  
  200. CONTACT
  201. -------
  202.  
  203. I hope you find this utility useful.  If you have any questions, ideas
  204. (for  this  program  or new ones), comments, bug reports, etc.  please
  205. mail them to the addresses below.  Thanks for using this program!
  206.  
  207. Snail Mail: Sam Yee
  208.             4595 Nanaimo St.
  209.             Vancouver, B.C.
  210.             Canada  V5N 5J5
  211.  
  212.   Internet: samy@sfu.ca
  213.    FidoNet: 1:153/765 (Terra Firma BBS @ 604-434-3665)
  214.